Doc tweaks
authorGlenn Morris <rgm@gnu.org>
Thu, 9 Oct 2014 00:47:30 +0000 (20:47 -0400)
committerGlenn Morris <rgm@gnu.org>
Thu, 9 Oct 2014 00:47:30 +0000 (20:47 -0400)
* doc/lispref/frames.texi (Multiple Terminals): Copyedits.

* lisp/frame.el (display-monitor-attributes-list): Doc tweaks.

* nt/README.W32, src/ChangeLog.10, src/w32term.c:
Standardize on "taskbar" rather than "task bar", since that is what
most references seem to use; e.g.
http://en.wikipedia.org/wiki/Taskbar
http://windows.microsoft.com/en-us/windows7/products/features/windows-taskbar

doc/lispref/ChangeLog
doc/lispref/frames.texi
lisp/ChangeLog
lisp/frame.el
nt/README.W32
src/ChangeLog.10
src/w32term.c

index 0b370699523b332f2930a8c98d86918e6cdf8ed2..f8d209f3cb113fed7851d62ea4682d41c638b247 100644 (file)
@@ -1,3 +1,7 @@
+2014-10-09  Glenn Morris  <rgm@gnu.org>
+
+       * frames.texi (Multiple Terminals): Copyedits.
+
 2014-10-08  Eli Zaretskii  <eliz@gnu.org>
 
        * frames.texi (Multiple Terminals): Improve the description of X
index 97c7b4b050515ead1927db2af20f87c59e8d3b6a..78679b877e4336806690edfd29c09d21d458a601 100644 (file)
@@ -356,12 +356,14 @@ that, if the monitor is not the primary monitor, some of the
 coordinates might be negative.
 
 @item workarea
-Position of the top-left corner and size of the work area in pixels as
-@samp{(@var{x} @var{y} @var{width} @var{height})}.  This is different
-from @samp{geometry} in that the various system windows, such as the
-task bar and side bar, are excluded from the work area.  Note that, if
-the monitor is not the primary monitor, some of the coordinates might
-be negative.
+Position of the top-left corner and size of the work area (``usable''
+space) in pixels as @samp{(@var{x} @var{y} @var{width} @var{height})}.
+This may be different from @samp{geometry} in that space occupied by
+various window manager features (docks, taskbars, etc.) may be
+excluded from the work area.  Whether or not such features actually
+subtract from the work area depends on the platform and environment.
+Again, if the monitor is not the primary monitor, some of the
+coordinates might be negative.
 
 @item mm-size
 Width and height in millimeters as @samp{(@var{width} @var{height})}
@@ -371,10 +373,14 @@ List of frames that this physical monitor dominates (see below).
 
 @item name
 Name of the physical monitor as @var{string}.
+
+@item source
+Source of the multi-monitor information as @var{string};
+e.g., @samp{XRandr} or @samp{Xinerama}.
 @end table
 
 @var{x}, @var{y}, @var{width}, and @var{height} are integers.
-@samp{name} may not be present.
+@samp{name} and @samp{source} may be absent.
 
 A frame is @dfn{dominated} by a physical monitor when either the
 largest area of the frame resides in that monitor, or (if the frame
@@ -389,14 +395,14 @@ display:
 @smalllisp
   (display-monitor-attributes-list)
   @result{}
-  (((geometry 0 0 1920 1080)   ;; Left hand monitor
-    (workarea 0 0 1920 1050)   ;; Bottom of screen used for task bar
+  (((geometry 0 0 1920 1080) ;; @r{Left-hand, primary monitor}
+    (workarea 0 0 1920 1050) ;; @r{A taskbar occupies some of the height}
     (mm-size 677 381)
     (name . "\\\\.\\DISPLAY1")
     (frames #<frame emacs@@host *foo* 0000000005BBDC48>
             #<frame emacs@@host *scratch* 000000008179D370>))
-   ((geometry 1920 0 1680 1050) ;; Right hand monitor
-    (workarea 1920 0 1680 1050) ;; Whole screen can be used
+   ((geometry 1920 0 1680 1050) ;; @r{Right-hand monitor}
+    (workarea 1920 0 1680 1050) ;; @r{Whole screen can be used}
     (mm-size 593 370)
     (name . "\\\\.\\DISPLAY2")
     (frames)))
index c3c516a31081fc4b510ec1f6da9a108f6886577a..1ea1aff7581a880467e4fdffbdf745e158732399 100644 (file)
@@ -1,3 +1,7 @@
+2014-10-09  Glenn Morris  <rgm@gnu.org>
+
+       * frame.el (display-monitor-attributes-list): Doc tweaks.
+
 2014-10-08  Eli Zaretskii  <eliz@gnu.org>
 
        * faces.el (display-grayscale-p): Mention in the doc string that
index 55e5899ca4c3879fd6820dfb94251fb7fee1c08c..08d4a136e1ca6f7e8c60cc3c78c05e2200027b86 100644 (file)
@@ -1587,16 +1587,25 @@ of attribute keys and values as follows:
 
  geometry -- Position and size in pixels in the form of (X Y WIDTH HEIGHT)
  workarea -- Position and size of the work area in pixels in the
-            form of (X Y WIDTH HEIGHT); this excludes task bar etc.
+            form of (X Y WIDTH HEIGHT)
  mm-size  -- Width and height in millimeters in the form of
             (WIDTH HEIGHT)
  frames   -- List of frames dominated by the physical monitor
  name (*) -- Name of the physical monitor as a string
+ source (*) -- Source of multi-monitor information as a string
 
-where X, Y, WIDTH, and HEIGHT are integers, which might be negative
-for monitors other than the primary one.  X and Y are coordinates
-of the top-left corner of the rectangle.  Keys labeled with (*) are
-optional.
+where X, Y, WIDTH, and HEIGHT are integers.  X and Y are coordinates
+of the top-left corner, and might be negative for monitors other than
+the primary one.  Keys labeled with (*) are optional.
+
+The \"work area\" is a measure of the \"usable\" display space.
+It may be less than the total screen size, owing to space taken up
+by window manager features (docks, taskbars, etc.).  The precise
+details depend on the platform and environment.
+
+The `source' attribute describes the source from which the information
+was obtained.  On X, this may be one of: \"Gdk\", \"XRandr\", \"Xinerama\",
+or \"fallback\".
 
 A frame is dominated by a physical monitor when either the
 largest area of the frame resides in the monitor, or the monitor
index c4e4cf351d427cb0937ac4032ce0cbe37f086c7e..c73b3b3ad0940bf537d60305f95a68144aa83afd 100644 (file)
@@ -220,7 +220,7 @@ See the end of the file for license conditions.
   key in HKEY_CURRENT_USER.  Just delete the whole Software\GNU\Emacs
   key.
 
-  The Start menu entry can be removed by right-clicking on the Task bar
+  The Start menu entry can be removed by right-clicking on the Taskbar
   and selecting Properties, then using the Remove option on the Start
   Menu Programs page.  (If you installed under an account with
   administrator privileges, then you need to click the Advanced button
index 8652546088d152eaef96c4585316416dd6af4c6e..bbcebf41d1e8d941eba2d7500ed35d2c5f14191f 100644 (file)
        * w32term.c (x_make_frame_visible): Use SystemParametersInfo with
        SPI_GETWORKAREA to find the dimensions of the screen work area,
        and adjust vertical position of the frame in order to avoid being
-       covered by the task bar.
+       covered by the taskbar.
 
        * w32fns.c (w32_createwindow): Use CW_USEDEFAULT instead of
        f->left_pos and SH_SHOW instead of f->top_pos in the call to
index 5a053b4fc0d3181bfcddc1cceaffa69f193763c5..66cdbfaecb01b4035f07de2251a90aee324c4dd6 100644 (file)
@@ -5959,7 +5959,7 @@ x_make_frame_visible (struct frame *f)
          RECT window_rect;
 
          /* Adjust vertical window position in order to avoid being
-            covered by a task bar placed at the bottom of the desktop. */
+            covered by a taskbar placed at the bottom of the desktop. */
          SystemParametersInfo (SPI_GETWORKAREA, 0, &workarea_rect, 0);
          GetWindowRect (FRAME_W32_WINDOW (f), &window_rect);
          if (window_rect.bottom > workarea_rect.bottom